home *** CD-ROM | disk | FTP | other *** search
/ Aminet 3 / Aminet 3 - July 1994.iso / Aminet / util / misc / man31.lha / Man3.1 / DOCS / English / Man.DOC < prev    next >
Encoding:
Text File  |  1994-05-02  |  6.5 KB  |  215 lines
  1. Document Man
  2.  
  3. Man v3.1 - © 1993,1994 by Markus Hillenbrand
  4. --------------------------------------------
  5.  
  6. Man is a program to view texts and docs from Shell or WB. Therefore the
  7. Commodity has to be started.
  8.  
  9.  
  10. 1. Requirements
  11. ~~~~~~~~~~~~~~~
  12.  
  13. You need:            - asl.library         v37
  14.                      - intuition.library   v37
  15.                      - gadtools.library    v37
  16.                      - graphics.library    v37
  17.                      - dos.library         v37
  18.              - icon.library        v37
  19.              - commodities.library v37
  20.                      - workbench.library   v37
  21.  
  22. Supported:           - locale.library      v38
  23.                      - reqtools.library    v38 (busy-pointer)
  24.  
  25. Recommended:         - a harddisk to use help-texts efficiently
  26.                      - "MultiView" from OS3.0 to read .guide files
  27.                      - "Amigaguide" from OS2.0, if you don´t have 3.0
  28.  
  29.  
  30. 2. Installer
  31. ~~~~~~~~~~~~
  32.  
  33. As the program 'installer' (© by Commodore) is not freely distributable
  34. and it is needed for installation, you must be sure to have it in the
  35. path of your shell (e.g. C:, SYS:Utilities, ...). You can find the program
  36. on your workbench-disk for OS2.0, OS2.1 or OS3.0.
  37.  
  38. If your version of installer does not work with the installation-script
  39. of man, you may install 'man' yourself:
  40.  
  41.    1. Click on the icon 'man' and drag it to 'Workbench:WBStartUp'.
  42.    2. If you have OS2.1, copy the directory 'Catalogs' to 'Locale:Catalogs'.
  43.  
  44.  
  45. 3. ToolTypes
  46. ~~~~~~~~~~~~
  47.  
  48. Starting the program, it searches for the following Tooltypes:
  49.  
  50. 3.1. CX_PRIORITY
  51. ~~~~~~~~~~~~~~~~
  52.  
  53. CX_PRIORITY=x, where x stands for a value with -128<x<128. This value
  54. represents the priority for the commodity. Default is 0.
  55.  
  56. 3.2. CX_POPKEY
  57. ~~~~~~~~~~~~~~
  58.  
  59. Here you can enter a hotkey which will open the config-window when 
  60. pressed. Default is 'ctrl lalt m'.
  61.  
  62. 3.3. DONOTWAIT
  63. ~~~~~~~~~~~~~~
  64.  
  65. This Entry is not important, it´s only neccesary for system-startup.
  66.  
  67. 3.4. HOTKEY
  68. ~~~~~~~~~~~
  69.  
  70. Here you can enter a hotkey which will open the text-requester when 
  71. pressed. Default is 'ctrl help'.
  72.  
  73. 3.5. DELAY
  74. ~~~~~~~~~~
  75.         
  76. This value lets the program wait at start until reading the list of 
  77. texts. This is especially useful if there´s a lot of disk-access during
  78. system-start. DELAY=10 stands for waiting 10 seconds until reading the
  79. list. 
  80.  
  81. 3.6. DATA
  82. ~~~~~~~~~
  83.  
  84. Here you can enter a filename under which the lists of texts will be 
  85. saved. Default is 'Work:Man.LST'.
  86.  
  87.  
  88. 4. Configuration
  89. ~~~~~~~~~~~~~~~~
  90.  
  91. To configure the program, type "man -c" or "man -config" in your shell.
  92. A window opens where you can enter several specifications.
  93.  
  94. This window can also be opened by double-clicking the program-icon or
  95. by activating the gadget 'Activate Window' in the program 'Exchange'
  96. (© by Commodore).
  97.  
  98. The opened window is an AppWindow. This means that you can drop icons
  99. on it. These icons will be added to the list in the listviewgadget.
  100.  
  101. The window is devided into four parts:
  102.  
  103. 4.1. List of Help-Texts
  104. ~~~~~~~~~~~~~~~~~~~~~~~
  105.  
  106. In the upper halp of the window there is a listview-gadget, where all
  107. actual texts are shown. On the right side there are some gadgets:
  108.  
  109. 4.1.1. Add
  110. ~~~~~~~~~~
  111.  
  112. If you activate this gadget, a requester wille be opened which lets you
  113. add one single textfile to the list of texts.
  114.  
  115. 4.1.2. Delete
  116. ~~~~~~~~~~~~
  117.  
  118. The text highlighted in the listview will be deletet by pressing this gadget.
  119.  
  120. 4.1.3. Edit
  121. ~~~~~~~~~~~
  122. The text highlighted in the listview can be edited by pressing this gadget
  123. (i.e. if the path has changed).
  124.  
  125. 4.1.4. ScanDir
  126. ~~~~~~~~~~~~~~
  127.  
  128. With this gadget you can search through a whole directory in order to find
  129. some texts. All subdirectories will be searched as well. This is especially
  130. useful by configuring the program for the first time, because it saves a 
  131. lot of time.
  132.  
  133. 4.1.5. DelAll
  134. ~~~~~~~~~~~~~
  135.  
  136. That means: delete all. This gadget lets you delete the whole list of
  137. texts. 
  138.  
  139. 4.2. Program to show texts
  140. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  141.  
  142. Here you can enter the program to use for viewing and reading texts (maybe 
  143. your favourite text-reader). The gadget on the right opens a requester.
  144.  
  145. 4.3. Standard-Gadgets
  146. ~~~~~~~~~~~~~~~~~~~~~
  147.  
  148. With 'Save' the actual list of texts will be saved. With 'Hide' the win-
  149. dow will be closed and with 'Quit' the program will be removed from memory.
  150. (Changes will NOT be saved).
  151.  
  152.  
  153. 5. Shell-usage
  154. ~~~~~~~~~~~~~~
  155.  
  156. To read a text from shell, you have to add its name in the command line.
  157. Here you must not enter the suffix! "Man lha" for example searches for
  158. lha.doc, lha.dok, lha.man, and ... in the list.
  159. This text will then be shown with your preferred text-reader. If you enter 
  160. "man -l" you´ll get a list of all texts.
  161. If you call man without any parameter, a window os opened where you can
  162. select a text.
  163. If you enter a pattern (#?, ? etc.), all texts matching this pattern will be
  164. listed. If only one text matches, it will be shown immediately.
  165. With "man -q" you can unload the commodity.
  166.  
  167. 6. Localization under WB2.1+
  168. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  169.  
  170. Since Workbench 2.1 the program can be localized, i.e. it can be translated
  171. into several languages. Therefor I added the C source of the catalog. In the
  172. original version only German, Swedish and English are supported.
  173. The C source can easily be changed, and with a suitable program (e.g. MakeCat 
  174. - © Paladin-Software etc.) you can rebuild the catalog.
  175. If you have created a new catalog it would be nice if you send me the new
  176. C source via e-mail. Perhaps I can add the new language in a newer version
  177. of man.
  178.  
  179.  
  180. 7. Copyright
  181. ~~~~~~~~~~~~
  182.  
  183. 'Man' is Copyright (C) 1993 Markus Hillenbrand and it's freely distributable
  184. as long as all of its files are included in their original form without
  185. additions, deletions, or modifications of any kind, and only a nominal fee
  186. is charged for its distribution. This software is provided *AS IS* without 
  187. warranty of any kind, either expressed or implied. By using 'Man', you agree
  188. to accept the entire risk as to the quality and performance of the program.
  189.  
  190. Of course, it was tested rather extensively before it was released...
  191.  
  192.  
  193. 8. Address of the author
  194. ~~~~~~~~~~~~~~~~~~~~~~~~
  195.  
  196. Here´s my address (bug-report, suggestions or something like that):
  197.  
  198.            Markus Hillenbrand
  199.            Weserstrasse 9
  200.            36124 Eichenzell-Loeschenrod 
  201.  
  202.            GERMANY
  203.  
  204.  
  205. or e-mail: m_hillen@informatik.uni-kl.de
  206.  
  207.  
  208. 9. Man pages
  209. ~~~~~~~~~~~~
  210.  
  211. If you intend to write a man page for this archive, please read the hints
  212. and tips in the directory "ManPages". 
  213. If you are interested in a package of man pages for the original AmigaDOS
  214. commands, feel free to contact Lars Oloffson (e-mail: pt93lo@pt.hk-r.se).
  215.